RoomParticipantStore

Room participant management related interfaces, managing participant permissions, device control, message muting and other operations.

Overview

RoomParticipantStore Manage participant permissions, device control, message muting and other operations in the room. Room participant management provides complete participant lifecycle management, including permission management, device control, message muting and other features. RoomParticipantStore provides a comprehensive set of APIs to manage room participant related operations.

Key Features

• Permission Management：Supports transferring owner, setting/revoking admin, kicking users and other operations

• Device Control：Supports closing participant devices, disabling all devices and other operations

• Message Muting：Supports muting individual users or all users

• Device Request/Invitation：Supports requesting to open device, inviting to open device and other bidirectional interactions

Tip: Participant status updates are delivered through state publisher. Subscribe to it to receive real-time updates about participant list.

Topics

Creating Instance

• RoomParticipantStore.create - Create object instance

Observing State and Events

• state - Reactive state containing participant list and device request info

• addRoomParticipantListener/removeRoomParticipantListener - Participant event callback

Participant List

• getParticipantList - Get participant list

Permission Management

• transferOwner - Transfer owner

• setAdmin - Set admin

• revokeAdmin - Revoke admin

• kickUser - Kick user

• updateParticipantNameCard - Update participant name card

• updateParticipantMetaData - Update participant metadata

Local Microphone Control

• muteMicrophone - Mute microphone

• unmuteMicrophone - Unmute microphone

Device Control

• closeParticipantDevice - Close participant device

• disableUserMessage - Mute user

• disableAllDevices - Disable all devices

• disableAllMessages - Mute all users

Device Request Operations

• requestToOpenDevice - Request to open device

• cancelOpenDeviceRequest - Cancel open device request

• approveOpenDeviceRequest - Approve open device request

• rejectOpenDeviceRequest - Reject open device request

Device Invitation Operations

• inviteToOpenDevice - Invite to open device

• cancelOpenDeviceInvitation - Cancel open device invitation

• acceptOpenDeviceInvitation - Accept open device invitation

• declineOpenDeviceInvitation - Decline open device invitation

See Also

• ParticipantRole

• RoomParticipant

• RoomParticipantListener

• DeviceRequestInfo

• KickedOutOfRoomReason